/*
Copyright 2022 The Dapr Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import { TypeDaprPubSubCallback } from "../DaprPubSubCallback.type";
import { KeyValueType } from "../KeyValue.type";
import { BulkSubscribeConfig } from "./BulkSubscribeConfig.type";
import { DaprPubSubRouteType } from "./DaprPubSubRouteType.type";

/**
 * PubSubSubscriptionOptionsType defines the options we can pass while subscribing
 */
export type PubSubSubscriptionOptionsType = {
  // Metadata
  metadata?: KeyValueType;

  // The deadletter topic path
  deadLetterTopic?: string;

  // The deadletter callback to call
  deadLetterCallback?: TypeDaprPubSubCallback;

  // The default callback
  callback?: TypeDaprPubSubCallback;

  // The route creation for a single route or DaprPubSubRouteType
  route?: string | DaprPubSubRouteType;

  // The settings for bulk subscribe
  bulkSubscribe?: BulkSubscribeConfig;
};
